List of XpertRule scripting commands

This section provides a list of XpertRule @commands and their support by the different Deployment options

Command

Desktop

Ajax.NET

JS Engine

Comment

Alert

 

Assign

 

AttribVals

 

AuditXML

Legacy

Legacy

 

 

BeginTranslate / EndTranslate

Translation Option

Breakpoint

Legacy

Legacy

 

 

Captured

Legacy

Legacy

 

 

CaptureDlg

Legacy

 

 

Chain

 

Clear

 

ClipboardGetText

 

 

 

ClipboardSetText

 

 

 

Concat

 

Conditional

 

Constrain

Constrains Inference Option

Copy

 

Date

 

DBCall

 

Debug

 

DecodeData

Legacy

 

DecodeDate

 

DecodeDataXML

 

DecodeDialogXML

 

DelFile

✔*

 

 

Dim

 

DLLcall

 

 

DLLclose

 

 

DLLopen

 

 

Do

DoCBR

 

 

DoEvents

 

 

 

EncodeData

Legacy

 

EncodeDataXML

 

EncodeDialogXML

 

 

Evaluate

 

Exclude

Legacy

Legacy

 

Exit

 

ExposedFromFile

Legacy

Legacy *

 

 

ExposedFromStr

Legacy

Legacy

 

 

ExposedToFile

Legacy

Legacy *

 

 

ExposedToStr

Legacy

Legacy

 

 

ExternalCssFile

 

ExternalScriptFile

 

FClose

✔*

 

 

FExists

✔*

 

 

FiredLeafIDs

 

 

FolderCopy

✔*

 

 

FolderDelete

✔*

 

 

FOpen

✔*

 

 

For / Next

 

FRead

✔*

 

 

FReset

✔*

 

 

FSelect

 

 

 

FWrite

✔*

 

 

GetBookMark

 

 

GetHowText

 

 

GetReportText

 

 

GetShare

✔*

 

 

GetValidVals

Legacy

Legacy

 

Constrains Inference Option

Help

Legacy

 

 

 

HierarchyFromFile

✔*

 

Hierarchy Option

HierarchyFromStr

 

Hierarchy Option

HierarchyToFile

✔*

 

Hierarchy Option

HierarchyToStr

 

Hierarchy Option

If / Endif

 

InitArray

 

Length

 

Listop

 

LogToNum

 

LookAheadReport

Legacy

 

 

Message

 

Legacy

 

NumToLog

 

ODBCconnect

✔**

 

 

ODBCconnectMode

✔**

 

 

ODBCdisconnect

✔**

 

 

ODBCexecSQL

✔**

 

 

ODBCgetResult

✔**

 

 

OLE2call

✔**

 

 

OLE2close

✔**

 

 

OLE2get

✔**

 

 

OLE2open

✔**

 

 

OLE2put

✔**

 

 

Pad

 

Pause

 

 

PopupURL

 

Pos

 

PreCapture

Legacy

 

 

Prog

Legacy

Legacy**

 

 

QAReportStr

Legacy

Legacy

 

RandSeed

 

 

ReadLn

✔*

 

 

ReadVariables

✔*

 

 

ReleaseShare

✔*

 

 

Rem

 

Repeat

 

Restart / RestartPos

 

Return

 

RunMode

 

SelectCase

 

SendMail

 

 

ServerPause

Legacy

 

 

SessionExtend

 

 

SetCookie

 

 Use with GetCookie function

SetDlgExitProc

Legacy

Legacy

 

SetErrorHandler

 

 

SetFocus

 

 

 

Shell

✔**

 

 

ShellExec

✔**

 

 

Split

 

Str

 

Time

 

UnCaptured

Legacy

Legacy

 

UnPad

 

Unzip

 

 

Upcase

 

URLFetch

 

URLParam

 

Val

 

While

 

With

 

 

WriteVariables

✔**

 

 

XMLdb

 

XMLfetch

 

 

XMLPost

Legacy

 

 

XMLset

 

 

 

XRApath

 

 

XRdoc

 

Zip

✔**

 

 

Notes:
* All @ commands in Knowledge Builder that deal with Windows text files are designed for the Windows Desktop deployment and, although they are still supported by the Ajax.net engine, great caution should be exercised when using these commands with the Ajax.net deployment as they are performed on the same web server for all users. This can create potential problems caused by the possibility of multiple simultaneous web users.
** Windows connectivity commands (for ODBC, OLE2, etc) in Knowledge Builder were designed for Windows Desktop deployment, and although they are still supported by the Ajax.net server engine, caution should be exercised when using them, as they may not be the most effective method of connectivity for web-based applications. Consider using alternative commands such as @DBCall & @URLFetch etc.
"Legacy" commands are carried from earlier versions of Knowledge Builder for the purpose of back compatibility and these should not be used for new development as they are not likely to be maintained in future.

Assign

AttribVals

Captured

CaptureDlg

Chain

Clear

ClipboardGetText

ClipboardSetText

Concat

Conditional

Copy

Date

Debug

DecodeData

DecodeDate

DelFile

Dim

DLLcall

DLLclose

DLLopen

Do

DoCBR

DoEvents

EncodeData

EncodeDataXML

Evaluate

Exclude

Exit

ExposedFromFile

ExposedFromStr

ExposedToFile

ExposedToStr

FClose

FExists

FOpen

For Next

FRead

FReset

FSelect

FWrite

GetReportText

GetShare

GetValidVals

Help

If

InitArray

Length

Listop

LogToNum

LookAheadReport

Message

NumToLog

ODBCconnect

ODBCconnectMode

ODBCdisconnect

ODBCexecSQL

ODBCgetResult

OLE2call

OLE2close

OLE2get

OLE2open

OLE2put

Pad

Pause

PopupURL

Pos

PreCapture

Prog

QAReportStr

RandSeed

ReadLn

ReadVariables

Regex

ReleaseShare

Rem

Repeat

Restart

Return

RunMode

SelectCase

SendMail

ServerPause

SessionExtend

SetCookie

SetDlgExitProc

SetErrorHandler

Shell

ShellExec

Split

Str

Time

UnCaptured

UnPad

Upcase

Val

While

With

WriteVariables

XMLset

XRApath

Functions